# PikaPython C 模块开发流程

我们依然以 keil 的仿真工程为例，如果还没有获得仿真工程，请首先在 [快速开始 -> keil 仿真工程](Keil%20%E4%BB%BF%E7%9C%9F%E5%B7%A5%E7%A8%8B.html) 章节获取工程。

### 新建模块接口

编写一个新的模块，首先需要编写模块接口文件，比如编写一个数学计算模块Math，第一步是编写 Math.pyi。

### 编写类接口

现在我们可以在 Math.pyi 里面新建类了，比如我们要新建一个 `Adder` 类来实现相关的加法运算，我们就可以在 Math.py 里面添加 `Adder` 类。

然后我们希望 `Adder` 可以为整形、浮点型数据提供加法运算，那么就可以添加 `byInt` 方法和 `byFloat` 方法。

```python
# Math.pyi
class Adder:
    def byInt(self, a:int, b:int)->int:
        pass
    def byFloat(self, a:float, b:float)->float:
        pass
```

使用 `...` 代替 `pass` 的写法也是合法的，例如：

```python
# Math.pyi
class Addr:
    def byInt(self, a:int, b:int)->int:...
    def byFloat(self, a:float, b:float)->float:...
```

上面的一段代码中我们定义了 `Adder` 类，并添加了两个方法的声明，```byInt(self, a:int, b:int)->int``` 表示方法名为 ```byInt ```,输入参数为 `a` 和 `b` ， `a` 和 `b` 的类型都是 `int` 型，而返回值也是 `int` 型，返回值由 `->int` 来确定，这都是 python 的标准语法，是带类型注解的写法。

python 中类的方法的第一个参数都是 `self` 这是 python 的语法所要求的。

我们再向 math.py 里面添加一个 `Multiplier` 类，用来实现乘法，`Multiplier` 的写法如下所示：

```python
# Math.pyi
class Multiplier:
    def byInt(self, a:int, b:int)->int:
        pass
    def byFloat(self, a:float, b:float)->float:
        pass
```

到此类接口就编写完成了。我们在 main.py 中引入 `Math` 模块，这样 Pika 预编译器就会去预编译 `Math` 模块了。

```python
# main.py
import Math
```

双击运行pika预编译器。

![](assets/image-20220916121255823.png)

打开 pikascript-api 文件夹可以发现，我们新编写的模块接口对应的头文件已经可以被预编译出来了。

![](assets/image-20220916121454812.png)

### 编写类的实现

直接编译一下试试。

发现编译报错了，提示是有四个函数没有找到定义。

![](assets/131119786-823a96e3-7ab3-45f8-8c7c-282ba9b7b863.png)

这是正常的，因为我们之前并没有为 `Math` 模块的类编写实现，下面我们就来编写这些类的实现。

为了模块管理的方便，我们把实现文件都放在 pikascript-lib 文件夹下，

![](assets/image-20220916121548065.png)

在 pikascript-lib 文件夹下，新建一个 Math 文件夹，用来放 `Math` 模块的实现代码。

![](assets/131120240-a4001fa4-1fd2-4b6b-82a2-191834ed781b.png)

然后在 Math 文件夹下新建 .c 文件，建议用 "模块名_类名.c" 的命名方式为每一个类新建一个 .c 文件，提高代码的清晰性。

![](assets/131120619-45ae3520-7b63-434b-8831-5b4d9f900cad.png)

然后我们在这两个 .c 文件里面编写类的方法实现。那么问题来了，我们如何知道应当编写哪些实现呢？

这个很简单，我们打开 Math_Multiplier.h 和 Math_Adder.h 就可以发现，我们需要编写的实现函数已经被自动声明好了。

```c
/* Math_Multiplier.h */
/* ******************************** */
/* Warning! Don't modify this file! */
/* ******************************** */
#ifndef __Math_Multiplier__H
#define __Math_Multiplier__H
#include <stdio.h>
#include <stdlib.h>
#include "PikaObj.h"

PikaObj *New_Math_Multiplier(Args *args);

double Math_Multiplier_byFloat(PikaObj *self, double a, double b);
int Math_Multiplier_byInt(PikaObj *self, int a, int b);

#endif
```

```c
/* Math_Adder.h */
/* ******************************** */
/* Warning! Don't modify this file! */
/* ******************************** */
#ifndef __Math_Adder__H
#define __Math_Adder__H
#include <stdio.h>
#include <stdlib.h>
#include "PikaObj.h"

PikaObj *New_Math_Adder(Args *args);

double Math_Adder_byFloat(PikaObj *self, double a, double b);
int Math_Adder_byInt(PikaObj *self, int a, int b);

#endif
```

然后我们直接在 Math_Adder.c 和 Math_Multipler.c 里面去实现这四个函数就 ok 了。

```c
/* Math_Adder.c */
#include "pikaScript.h"

double Math_Adder_byFloat(PikaObj *self, double a, double b)
{
	return a + b;
}

int Math_Adder_byInt(PikaObj *self, int a, int b)
{
	return a + b;
}
```

```c
/* Math_Multipler.c */
#include "pikaScript.h"

double Math_Multiplier_byFloat(PikaObj *self, double a, double b)
{
	return a * b;
}

int Math_Multiplier_byInt(PikaObj *self, int a, int b)
{
	return a * b;
}
```

这时,再编译项目，就可以通过了。

### 测试一下效果

我们用下面的 main.py 来测试一下我们新编写的模块

```python
# main.py
import Math

adder = Math.Adder()
muler = Math.Multiplier()

res1 = adder.byInt(1, 2)
print('1 + 2')
print(res1)

res2 = adder.byFloat(2.3, 4.2)
print('2.3 + 4.2')
print(res2)

res3 = muler.byInt(2, 3)
print('2 * 3')
print(res3)

res4 = muler.byFloat(2.3, 44.2)
print('2.3 * 44.2')
print(res4)
```

运行的效果如下：

![](assets/131123307-1d9564d1-8b99-4784-99ed-9756693781f1.png)

这说明我们编写的模块工作正常了。

### 可用的类型注解

下面的表格列出了 PikaPython 支持的所有类型声明,以及它们与 C 语言的原生类型的对应关系。

| Python 类型注解 | C  原生类型 | 说明 |
| --------------- | ----------- | -- |
| int             | int         | python 基本类型 |
| int64           | int64_t     | 64 位整型  |
| float           | double       | python 基本类型 |
| str             | char *       | python 基本类型 |
| bytes           | uint8_t *    | python 基本类型 |
| pointer         | void *       | PikaPython 特有的类型注解 |
| any             | Arg*        |PikaPython 提供的泛型容器|
| 任意 class      | PikaObj *   |PikaPython 提供的对象容器|

> **注意**
> 1. `str` 作为返回值时，在 c 中返回的是 `char*` ，如果要返回的字串是函数中的局部变量，需要用 `obj_cacheStr` 进行缓存，避免出函数作用域后发生悬垂引用，如: `return obj_cacheStr(self, res);`。
> 2. `bytes` 作为返回值时，在 c 中返回的是 `Arg*`，这是因为 `bytes` 需要指定长度，返回 `uint8_t*` 不能达到要求。正确返回方式为：`return arg_newBytes(bytes, len);`。

### 发布模块

出于开源的精神，发布你自己的模块是一件非常酷且激动人心的事情。

发布模块只需要发布类接口和类实现文件即可。

比如发布刚刚新编写的 Math 模块，就是发布 Math.pyi 文件和 pikascript-lib/Math 文件夹里的文件。

![](assets/image-20220916121755609.png)

请参考 [参与社区贡献->贡献模块](%E5%A6%82%E4%BD%95%E8%B4%A1%E7%8C%AE%20PikaScript%20%E6%A8%A1%E5%9D%97.html) 部分的文档发布你编写的模块。